/*
 * Alloy Analyzer
 * Copyright (c) 2002 Massachusetts Institute of Technology
 *
 * The Alloy Analyzer is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * The Alloy Analyzer is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with the Alloy Analyzer; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package alloy.ast;

import alloy.semantic.LocalScope;
import alloy.transform.LeafIdMap;

public class ComprehensionExpr extends TypedExpr implements VarCreator {

    /**
     * index of decls in child list
     */
    private static final int DECLS_INDEX = 0;

    /**
     * index of formula in child list
     */
    private static final int FORMULA_INDEX = 1;

    /** local scope associated with this */
    private LocalScope _localScope;
    
    /** leaf id map associated with this */
    private LeafIdMap _leafIdMap;

    public ComprehensionExpr(Location location_, Decls decls_, Formula formula_, boolean isTyped) {
        super(location_, decls_, formula_);
        if (isTyped) _localScope = LocalScope.genScopeFromDecls(decls_);
    }


    public ComprehensionExpr(Decls decls_, Formula formula_, boolean isTyped) {
        this(Location.UNKNOWN, decls_, formula_, isTyped);
    }



    //GET AND SET METHODS

    /**
     * gets the decls of this
     * @return the {@link Decls}
     */
    public Decls getDecls() {
        return (Decls)childAt(DECLS_INDEX);
    }

    /** set the Decls of this */
    public void setDecls(Decls newChild_) {
        setChild(DECLS_INDEX, newChild_);
    }

    /**
     * gets the formula of this
     * @return the {@link Formula}
     */
    public Formula getFormula() {
        return (Formula)childAt(FORMULA_INDEX);
    }

    /** set the Formula of this */
    public void setFormula(Formula newChild_) {
        setChild(FORMULA_INDEX, newChild_);
    }

    public Node getBody() {
        return childAt(FORMULA_INDEX);
    }

    /** set the Body of this */
    public void setBody(Node newChild_) {
        setChild(FORMULA_INDEX, newChild_);
    }

    /**
     * gets the local scope of this
     * @return the local scope
     */
    public LocalScope getLocalScope() {
        return _localScope;
    }

    /**
     * sets the local scope of this
     * @param localScope_ the new local scope for this
     */
    public void setLocalScope(LocalScope localScope_) {
        _localScope = localScope_;
    }

    /**
     * gets the leaf id map of this
     * @return the leaf id map
     */
    public LeafIdMap getLeafIdMap() {
        return _leafIdMap;
    }

    /**
     * sets the leaf id map of this
     * @param leafIdMap_ the new leaf id map for this
     */
    public void setLeafIdMap(LeafIdMap leafIdMap_) {
        _leafIdMap = leafIdMap_;
    }

    /**
     * accept an AST visitor
     * @param visitor_ the visitor
     */
    protected void acceptVisitor(ASTVisitor visitor_) {
        visitor_.visit(this);
    }

    public Object copy() {
	ComprehensionExpr ret = (ComprehensionExpr)super.copy();
	ret._leafIdMap = null;
	//	localScope copying for atomization--should confirm this doesn't affect other code
	if (_localScope != null)
	    ret._localScope = _localScope.copy();

	return ret;
    }
	
    /**
     * accept a returning AST visitor
     * @param visitor_ the visitor
     * @return the Object returned by the visitor
     */
    protected Object acceptReturnVisitor(ASTReturnVisitor visitor_) {
        return visitor_.visit(this);
    }

    public String nodeString() {
        StringBuffer ret = new StringBuffer("{ " + getDecls().nodeString());
        // check for empty formula to eliminate "|" character
        if (!(getFormula() instanceof EmptyFormula)) {
            ret.append(" | " + getFormula().nodeString());
        }
        ret.append(" }");
        return ret.toString();
    }

    public String toString()
    {
        return nodeString();
    }

    public boolean isSameAs(Node node_) { return false; }
}

